Vcenter Vm Hardware Ethernet CreateSpec

Vcenter Vm Hardware Ethernet CreateSpec
Vcenter Vm Hardware Ethernet CreateSpec

The Vcenter Vm Hardware Ethernet CreateSpec schema provides a specification for the configuration of a newly-created virtual Ethernet adapter.

JSON Example
{
    "type": "string",
    "upt_compatibility_enabled": false,
    "upt_v2_compatibility_enabled": false,
    "mac_type": "string",
    "mac_address": "string",
    "pci_slot_number": 0,
    "wake_on_lan_enabled": false,
    "backing": {
        "type": "string",
        "network": "string",
        "distributed_port": "string"
    },
    "start_connected": false,
    "allow_guest_control": false
}
string
type
Optional

Ethernet adapter emulation type.

For more information see: Vcenter Vm Hardware Ethernet EmulationType.

If missing or null, defaults to a guest-specific type.

boolean
upt_compatibility_enabled
Optional

Flag indicating whether Universal Pass-Through (UPT) compatibility is enabled on this virtual Ethernet adapter.

If missing or null, UPT will not be enabled on the newly-created virtual Ethernet adapter.

boolean
upt_v2_compatibility_enabled
Optional

Flag indicating whether Uniform Pass-through version 2(UPTv2) compatibility is enabled on this network adapter. To enable this feature, the network adapter must connect to a network backed by DPU (Data Processing Unit) and network offloading must be enabled on the network.

This property was added in vSphere API 8.0.0.1.

If missing or null, UPTv2 will not be enabled on the newly-created virtual Ethernet adapter.

string
mac_type
Optional

MAC address type.

For more information see: Vcenter Vm Hardware Ethernet MacAddressType.

If missing or null, defaults to Vcenter Vm Hardware Ethernet MacAddressType.GENERATED.

string
mac_address
Optional

MAC address.

Workaround for PR1459647

integer As int64 As int64
pci_slot_number
Optional

Address of the virtual Ethernet adapter on the PCI bus. If the PCI address is invalid, the server will change when it the VM is started or as the device is hot added.

If missing or null, the server will choose an available address when the virtual machine is powered on.

boolean
wake_on_lan_enabled
Optional

Flag indicating whether wake-on-LAN is enabled on this virtual Ethernet adapter.

Defaults to false if missing or null.

backing
Optional

Physical resource backing for the virtual Ethernet adapter.

If missing or null, the system may try to find an appropriate backing. If one is not found, the request will fail.

boolean
start_connected
Optional

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

Defaults to false if missing or null.

boolean
allow_guest_control
Optional

Flag indicating whether the guest can connect and disconnect the device.

Defaults to false if missing or null.